<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibCDS: HashMap Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibCDS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structHashMap.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">HashMap Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The implementation for hash map.  
 <a href="structHashMap.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aef83bfc8e8bc94e4ee0aee547baa7a27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="hash__map_8h.html#a9ba28ae908982272687dd668de83780a">HashMapData</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHashMap.html#aef83bfc8e8bc94e4ee0aee547baa7a27">pData</a></td></tr>
<tr class="memdesc:aef83bfc8e8bc94e4ee0aee547baa7a27"><td class="mdescLeft">&#160;</td><td class="mdescRight">The container private information.  <a href="#aef83bfc8e8bc94e4ee0aee547baa7a27">More...</a><br/></td></tr>
<tr class="separator:aef83bfc8e8bc94e4ee0aee547baa7a27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e5c1a720833b69cbd83ccf2d2664b62"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHashMap.html#a7e5c1a720833b69cbd83ccf2d2664b62">put</a> )(struct _HashMap *, Pair *, size_t)</td></tr>
<tr class="memdesc:a7e5c1a720833b69cbd83ccf2d2664b62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a key value pair into the map.  <a href="#a7e5c1a720833b69cbd83ccf2d2664b62">More...</a><br/></td></tr>
<tr class="separator:a7e5c1a720833b69cbd83ccf2d2664b62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59de022d954bb25adc5898a2c5c84f93"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHashMap.html#a59de022d954bb25adc5898a2c5c84f93">get</a> )(struct _HashMap *, Key, size_t, Value *)</td></tr>
<tr class="memdesc:a59de022d954bb25adc5898a2c5c84f93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the value corresponding to the designated key.  <a href="#a59de022d954bb25adc5898a2c5c84f93">More...</a><br/></td></tr>
<tr class="separator:a59de022d954bb25adc5898a2c5c84f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56c9e15c9a2f15e319acc0cd983279fb"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHashMap.html#a56c9e15c9a2f15e319acc0cd983279fb">find</a> )(struct _HashMap *, Key, size_t)</td></tr>
<tr class="memdesc:a56c9e15c9a2f15e319acc0cd983279fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the map contains the designated key.  <a href="#a56c9e15c9a2f15e319acc0cd983279fb">More...</a><br/></td></tr>
<tr class="separator:a56c9e15c9a2f15e319acc0cd983279fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc566a2cf7a0a421ae6522bb73e69860"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHashMap.html#adc566a2cf7a0a421ae6522bb73e69860">remove</a> )(struct _HashMap *, Key, size_t)</td></tr>
<tr class="memdesc:adc566a2cf7a0a421ae6522bb73e69860"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the key value pair corresponding to the designated key.  <a href="#adc566a2cf7a0a421ae6522bb73e69860">More...</a><br/></td></tr>
<tr class="separator:adc566a2cf7a0a421ae6522bb73e69860"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f99aaee737bfb5ab7804db8559b4853"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHashMap.html#a6f99aaee737bfb5ab7804db8559b4853">size</a> )(struct _HashMap *)</td></tr>
<tr class="memdesc:a6f99aaee737bfb5ab7804db8559b4853"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of stored key value pairs.  <a href="#a6f99aaee737bfb5ab7804db8559b4853">More...</a><br/></td></tr>
<tr class="separator:a6f99aaee737bfb5ab7804db8559b4853"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54623cbc411f079c0653ebf0b20b0452"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHashMap.html#a54623cbc411f079c0653ebf0b20b0452">iterate</a> )(struct _HashMap *, bool, Pair **)</td></tr>
<tr class="memdesc:a54623cbc411f079c0653ebf0b20b0452"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterate through the map to retrieve each key value pair.  <a href="#a54623cbc411f079c0653ebf0b20b0452">More...</a><br/></td></tr>
<tr class="separator:a54623cbc411f079c0653ebf0b20b0452"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae65414b0bd1586f4482640e790fdd445"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHashMap.html#ae65414b0bd1586f4482640e790fdd445">set_destroy</a> )(struct _HashMap *, void(*)(Pair *))</td></tr>
<tr class="memdesc:ae65414b0bd1586f4482640e790fdd445"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the custom key value pair resource clean method.  <a href="#ae65414b0bd1586f4482640e790fdd445">More...</a><br/></td></tr>
<tr class="separator:ae65414b0bd1586f4482640e790fdd445"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d773cae38845791bb20462fd9f6c099"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHashMap.html#a2d773cae38845791bb20462fd9f6c099">set_hash</a> )(struct _HashMap *, uint32_t(*)(Key, size_t))</td></tr>
<tr class="memdesc:a2d773cae38845791bb20462fd9f6c099"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the custom hash function.  <a href="#a2d773cae38845791bb20462fd9f6c099">More...</a><br/></td></tr>
<tr class="separator:a2d773cae38845791bb20462fd9f6c099"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The implementation for hash map. </p>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00014">14</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="aef83bfc8e8bc94e4ee0aee547baa7a27"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="hash__map_8h.html#a9ba28ae908982272687dd668de83780a">HashMapData</a>* HashMap::pData</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The container private information. </p>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00016">16</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>

</div>
</div>
<a class="anchor" id="a7e5c1a720833b69cbd83ccf2d2664b62"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t(* HashMap::put)(struct _HashMap *, Pair *, size_t)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Insert a key value pair into the map. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="hash__map_8h.html#a243335e4bfd9e7efb7f5e7925c4d0d74" title="Insert a key value pair into the map. ">HashMapPut</a> </dd></dl>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00020">20</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>

</div>
</div>
<a class="anchor" id="a59de022d954bb25adc5898a2c5c84f93"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t(* HashMap::get)(struct _HashMap *, Key, size_t, Value *)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve the value corresponding to the designated key. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="hash__map_8h.html#a949863ffee4bf0b02e80953dc989a828" title="Retrieve the value corresponding to the designated key. ">HashMapGet</a> </dd></dl>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00024">24</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>

</div>
</div>
<a class="anchor" id="a56c9e15c9a2f15e319acc0cd983279fb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t(* HashMap::find)(struct _HashMap *, Key, size_t)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check if the map contains the designated key. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="hash__map_8h.html#a529685800e567cf5b960a81c17c1aa1d" title="Check if the map contains the designated key. ">HashMapFind</a> </dd></dl>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00028">28</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>

</div>
</div>
<a class="anchor" id="adc566a2cf7a0a421ae6522bb73e69860"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t(* HashMap::remove)(struct _HashMap *, Key, size_t)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Delete the key value pair corresponding to the designated key. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="hash__map_8h.html#a1f245b96b890186f93987728f2dea402" title="Delete the key value pair corresponding to the designated key. ">HashMapRemove</a> </dd></dl>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00032">32</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6f99aaee737bfb5ab7804db8559b4853"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t(* HashMap::size)(struct _HashMap *)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return the number of stored key value pairs. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="hash__map_8h.html#a8af14c3c4205f0a0b2a1dd75694b3bf4" title="Return the number of stored key value pairs. ">HashMapSize</a> </dd></dl>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00036">36</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>

</div>
</div>
<a class="anchor" id="a54623cbc411f079c0653ebf0b20b0452"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t(* HashMap::iterate)(struct _HashMap *, bool, Pair **)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Iterate through the map to retrieve each key value pair. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="hash__map_8h.html#aba029e83455fdbaf0d8a464dc4e3d381" title="Iterate through the map to retrieve each key value pair. ">HashMapIterate</a> </dd></dl>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00040">40</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae65414b0bd1586f4482640e790fdd445"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t(* HashMap::set_destroy)(struct _HashMap *, void(*)(Pair *))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the custom key value pair resource clean method. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="hash__map_8h.html#af937beb03d236fd4dc9a846fcb97eff4" title="Set the custom key value pair resource clean method. ">HashMapSetDestroy</a> </dd></dl>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00044">44</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>

</div>
</div>
<a class="anchor" id="a2d773cae38845791bb20462fd9f6c099"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t(* HashMap::set_hash)(struct _HashMap *, uint32_t(*)(Key, size_t))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the custom hash function. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="hash__map_8h.html#abbce9df57c7395e441c226919937d67f" title="Set the custom hash function. ">HashMapSetHash</a> </dd></dl>

<p>Definition at line <a class="el" href="hash__map_8h_source.html#l00048">48</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structHashMap.html">HashMap</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
